API Documentation
BlurComplexEffect.h
1 // BlurComplexEffect.h
3 //
5 
6 namespace nkAstraeus
7 {
13  class BlurComplexEffect final : public ComplexEffect
14  {
15  public :
16 
29 
30  // Getters
34  virtual COMPLEX_EFFECT_TYPE getType () const override ;
49  unsigned int getKernelRadius () const ;
53  bool getAlphaEncodesBlurPlanes () const ;
57  bool getPreserveAlpha () const ;
58 
59  // Setters
76  void setKernelRadius (unsigned int value) ;
87  void setAlphaEncodesBlurPlanes (bool value) ;
98  void setPreserveAlpha (bool value) ;
99 
100  // Load
104  virtual bool load () override ;
108  virtual void unload () override ;
109  } ;
110 }
nkAstraeus::BlurComplexEffect::setSourceTexture
void setSourceTexture(nkGraphics::Texture *value)
nkAstraeus::BlurComplexEffect
A blurring effect.
Definition: BlurComplexEffect.h:14
nkAstraeus::COMPLEX_EFFECT_TYPE
COMPLEX_EFFECT_TYPE
Enumerates all complex effects available in the component.
Definition: ComplexEffectType.h:12
nkAstraeus::BlurComplexEffect::getPreserveAlpha
bool getPreserveAlpha() const
nkAstraeus::BlurComplexEffect::~BlurComplexEffect
~BlurComplexEffect()
nkAstraeus::BlurComplexEffect::setKernelRadius
void setKernelRadius(unsigned int value)
nkGraphics::Texture
A texture used for rendering, hosted on GPU.
Definition: Texture.h:35
nkAstraeus::BlurComplexEffect::BlurComplexEffect
BlurComplexEffect(nkMemory::StringView name)
nkAstraeus::BlurComplexEffect::getType
virtual COMPLEX_EFFECT_TYPE getType() const override
nkAstraeus::BlurComplexEffect::setPreserveAlpha
void setPreserveAlpha(bool value)
nkAstraeus::ComplexEffect
Base class for all complex effects in the component.
Definition: ComplexEffect.h:18
nkAstraeus
Encompasses all API of component NilkinsAstraeus.
Definition: Engine.h:7
nkAstraeus::BlurComplexEffect::getSourceTexture
nkGraphics::Texture * getSourceTexture() const
nkMemory::StringView
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
nkAstraeus::BlurComplexEffect::load
virtual bool load() override
nkAstraeus::BlurComplexEffect::unload
virtual void unload() override
nkAstraeus::BlurComplexEffect::getAlphaEncodesBlurPlanes
bool getAlphaEncodesBlurPlanes() const
nkAstraeus::BlurComplexEffect::getKernelRadius
unsigned int getKernelRadius() const
nkAstraeus::BlurComplexEffect::setAlphaEncodesBlurPlanes
void setAlphaEncodesBlurPlanes(bool value)
nkAstraeus::BlurComplexEffect::getOutputTexture
nkGraphics::Texture * getOutputTexture() const